Documents

[PUT] /api/v2/common/documents/{id}/thumbnails/upload

上传文档缩略图。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

返回值

状态码: 200

成功

ThumbnailUploadResponseModel

状态码: 400

错误的请求

ServerPluginError

[DELETE] /api/v2/common/documents/{id}/thumbnails

删除指定文档缩略图。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/referenced-documents/update

更新依赖于指定文档的文档，使其引用指定文档的最新版本。

参数:

名称	类型	位置	描述
id必填项	string	path	指定文档 ID。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/documents/{id}

根据文档 ID 删除文档。此操作可以是软删除，也可以是硬删除，具体取决于配置和请求参数。

参数:

名称	类型	位置	描述
id必填项	string	path	要删除的文档的唯一标识符。例如：“1E5D7247-450E-4383-B0DD-09D5CF651907”。

请求数据格式

DocumentDeleteRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}

使用文档的唯一标识符检索有关文档的详细信息。

参数:

名称	类型	位置	描述
id必填项	string	path	文档 ID。示例：e3808c7e-c0e7-44da-96a2-200b3bb216c6
extendQuery	ExtendQuery	query	查询响应的详细级别。例如：参考文献、修订版本
includeIndirectReference	Boolean	query	当为真时，包含间接引用。与 extendQuery 中的引用相关。
deleted	Boolean	query	如果为真，则仅查询已删除的文档；如果为假，则仅查询未删除的文档。

返回值

状态码: 200

成功

DocumentVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/batch-delete

根据提供的请求模型，执行批量文档删除操作。此操作可配置为执行软删除或硬删除。

请求数据格式

BatchDeleteDocumentsRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/restore

恢复文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/batch-restore

批量恢复文档。

请求数据格式

BatchRestoreDocumentsRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/common/documents/{id}/properties

更新文档属性

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

请求数据格式

DocumentPropertyRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/batch-hide-in-document-portal

在文档门户中批量隐藏文档。

请求数据格式

BatchHideDocumentInDocumentPortalRequestModel

返回值

状态码: 200

成功

BatchHideDocumentInDocumentPortalResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/{id}/duplicate

重复文档。使用范围：数据模型、数据集、报表、仪表盘、语言资源。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907

请求数据格式

CopyDocumentRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{documentId}/tags/{tagId}

向文档添加指定的标签。

参数:

名称	类型	位置	描述
documentId必填项	string	path	要添加标签的文档的唯一标识符。
tagId必填项	string	path	要添加到文档中的标签的唯一标识符。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/documents/{documentId}/tags/{tagId}

从文档中移除指定的标签。

参数:

名称	类型	位置	描述
documentId必填项	string	path	要从中移除标签的文档的唯一标识符。
tagId必填项	string	path	要从文档中删除的标签的唯一标识符。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/tags/modify

根据指定的操作更改一批文档的类别（标签）。

This method supports adding, removing, or replacing tags for a batch of documents. The operation type in the request model determines the action to be performed.

请求数据格式

ChangeCategoriesRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[PUT] /api/v2/common/documents/homepage

将指定文档设置为当前用户的主页文档。此操作会更新用户的个人资料，使其将指定文档作为主页文档。

This method checks if the specified document exists and if the current user's information is available. If the document exists
and the user is valid, it updates the user's profile to set the specified document as their home document. This method handles
various exceptions, including cases where the home document is already set, the document is not found, or any database access issues occur.

请求数据格式

SetHomeDocumentRequestModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/search

根据指定条件查询分页文档列表，支持筛选、排序和分页控制。

请求数据格式

QueryDocumentsWithPaginationRequestModel

返回值

状态码: 200

成功

DocumentPaginationResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/favorites

带分页的查询文档

请求数据格式

DocumentTagPaginationRequestModel

返回值

状态码: 200

成功

DocumentPaginationResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/documents/document-types

查询并检索系统中所有可用文档类型的列表。

参数:

名称	类型	位置	描述
key	string	query

返回值

状态码: 200

成功

QueryDocumentTypesResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/documents/{id}/document-translate-titles

更新文档翻译标题

参数:

名称	类型	位置
id必填项	string	path

请求数据格式

DocumentTranslateTitleRequest

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}/document-translate-titles

获取文档所有翻译标题

参数:

名称	类型	位置
id必填项	string	path

返回值

状态码: 200

成功

DocumentTranslateTitle

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/documents/{id}/document-translate-titles/{languageCode}

按语言代码获取文档翻译标题

参数:

名称	类型	位置	描述
id必填项	string	path
languageCode必填项	string	path	语言代码。例如：EN

返回值

状态码: 200

成功

DocumentTranslateTitle

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/encrypt-url

对给定的 URL 路径进行加密，并返回加密后的 URL 路径。

请求数据格式

EncryptPathRequestModel

返回值

状态码: 200

成功

EncryptPathResponseModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/admin/export

导出文件及其参考编号。

请求数据格式

ExportRequestModel

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/admin/import

导入文件。

返回值

状态码: 200

成功

ImportResult

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/common/documents/{id}/permission

更新文档权限

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号

请求数据格式

PermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/permissions/batch-update

批量更改文档权限

请求数据格式

BatchChangePermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/{id}/permission/apply-min-needed-permission

根据文档的当前权限，对文档的子文档应用必要的最小权限。

参数:

名称	类型	位置	描述
id必填项	string	path	文档的唯一标识符。

请求数据格式

MinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/permission/batch-apply-min-needed-permission

批量授予对当前文档所引用文档的最小所需权限

请求数据格式

BatchApplyMinNeededPermissionRequestModel

返回值

状态码: 200

成功

DocumentResponseModel

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/resources/download

批量下载资源。

参数:

名称	类型	位置	描述
ids	string	query	文档 ID。例如：["F00FC3E6-8554-467D-9A7E-4598E623BB2F", "8259E551-5AFB-489E-8593-0FD6384E123B"]

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/resources/{id}/download

获取资源。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：1E5D7247-450E-4383-B0DD-09D5CF651907
rev	int32	query	文档版本。例如：null 或 1

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/common/documents/upload

上传文件。

返回值

状态码: 200

成功

QueueStatsResponseModel

状态码: 400

错误的请求

ServerPluginError

类型定义

Ƭ ThumbnailUploadResponseModel

表示上传文档缩略图响应模型。

名称	类型	描述	示例
thumbnailUrl可为空	string	文档缩略图网址。

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError
extensions可为空	any	扩展结果

Ƭ DocumentResponseModel

表示文档的响应模型，包括其元数据和状态。

名称	类型	描述	示例
documentId可为空	string	获取或设置文档的唯一标识符。
title可为空	string	获取或设置文档标题。
fileExt可为空	string	获取或设置文档的文件扩展名。
contentType可为空	string	获取或设置文档的内容类型。
creatorName可为空	string	获取或设置文档创建者的名称。
modifierName可为空	string	获取或设置最后修改文档的人员姓名。
deleterName可为空	string	获取或设置删除文档的人员姓名（如果适用）。
description可为空	string	获取或设置文档的描述。
isSystemReserved可为空	Boolean	获取或设置一个值，该值指示文档是否已被系统预留。
isResource	Boolean	获取或设置一个值，该值指示文档是否被视为资源。
hideOnMobile可为空	Boolean	获取或设置一个值，该值指示文档是否应在移动设备上隐藏。
meta可为空	string	获取或设置与文档关联的元数据。
hideInDocumentPortal可为空	Boolean	获取或设置一个值，该值指示是否应在文档门户中隐藏文档。
organizationId可为空	string	获取或设置与文档关联的组织 ID。
organizationIdPath可为空	string	获取或设置与文档关联的组织 ID 的路径。
thumbnail可为空	string	获取或设置文档的缩略图。
schemaVersion可为空	string	获取或设置文档的模式版本。

Ƭ DocumentDeleteRequestModel

表示删除文档的请求模型。它包括强制删除和永久删除选项。

名称	类型	描述	示例
force	Boolean	获取或设置一个值，该值指示是否应强制删除文档。强制删除会绕过任何软删除机制。	true
permanent	Boolean	获取或设置一个值，该值指示是否应永久删除文档。永久删除会将文档从数据库中彻底移除。

Ƭ ExtendQuery

Enum:

• None
• EffectiveOps
• Security
• References
• Revisions
• Tags
• Draft
• All

定义用于扩展文档查询的选项。

此枚举允许指定应在文档查询响应中包含哪些附加数据。
它支持位运算以组合多个选项。

* None - 0 - 不包含任何附加数据。
* EffectiveOps - 1 - 包含适用于文档的有效操作。
* Security - 2 - 包含安全信息，例如访问控制列表。
* References - 4 - 包含对其他文档的引用。
* Revisions - 8 - 包含有关文档修订的信息。
* Tags - 16 - 包含与文档关联的标签。
* Draft - 32 - 包含与文档关联的草稿信息。
* All - 63 - 包含所有可用的扩展信息。

Ƭ DocumentVO

表示文档的视图对象，封装了各种元数据和状态信息。

名称	类型	描述	示例
created可为空	ISO DateTime Sting	文档的创建时间戳。
deleted可为空	ISO DateTime Sting	如果文档已被删除，则显示文档的删除时间戳。
modified可为空	ISO DateTime Sting	文档的最后修改时间戳。
createdBy	SampleUserResponseModel
modifiedBy	SampleUserResponseModel
deletedBy	SampleUserResponseModel
description可为空	string	文件简介。
displayName可为空	string	文档的显示名称。
ext可为空	string	文档的文件扩展名。
hideInDocumentPortal	Boolean	指示文档是否在文档门户中隐藏。
hideOnMobile	Boolean	指示该文档是否在移动设备上隐藏。
id可为空	string	文档的唯一标识符。
isResource	Boolean	指示该文档是否为资源。
meta可为空	string	与文档相关的元数据。
organizationId可为空	string	与该文档关联的组织 ID。
organizationIdPath可为空	string	与文档关联的组织 ID 路径。
thumbnail可为空	string	文档缩略图的URL。
title可为空	string	文档标题。
type可为空	string	文档类型。
customPermissions可为空	Array<string>	与文档关联的自定义权限。
contentUrl可为空	string	访问文档内容的URL。
revisionNo	int32	文档的修订号。
revisionContentUrl可为空	string	访问特定文档版本内容的URL。
isSystemReserved	Boolean	指示该文档是否已被系统预留。
effectiveOps可为空	string	允许对文档进行有效操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	与该文档相关的参考文献。
revisions可为空	RevisionResponseModel	文档修订历史。
tags可为空	TagResponseInfoModel	与文档关联的标签。
draft	DraftVO

Ƭ SampleUserResponseModel

代表一个简化的用户模型，提供各种响应模型中使用的基本信息。

名称	类型	描述	示例
id可为空	string	用户的唯一标识符。
name可为空	string	用户名。

Ƭ SecurityResponseModel

文档的安全设置。

名称	类型	描述	示例
ownerId可为空	string	所有者的唯一标识符。
permissions可为空	AclEntryQueryModel	文档访问权限。

Ƭ ReferenceResponseModel

表示文档引用的模型，包括有关文档及其权限的详细信息。

名称	类型	描述	示例
documentId可为空	string	被引用文档的唯一标识符。
resourceName可为空	string	文档所关联的资源名称。
resourceDocType可为空	string	资源文档的类型。
resourceDocExt可为空	string	文档的文件扩展名。
resourceDocName可为空	string	资源文档的名称。
directReferencesIds可为空	Array<string>	父文档 ID。
displayName可为空	string	参考文献的显示名称。
meta可为空	string	与文档相关的元数据。
documentRev可为空	string	文件修订。
isDirectChild	Boolean	指示该文档是否为父文档的直接子文档。
permission可为空	string	文档的权限级别。
contentUrl可为空	string	访问文档内容的URL。
minimalPermission可为空	string	访问该文档所需的最低权限。

Ƭ RevisionResponseModel

表示文档修订的模型，包括修订号、注释、元数据和相关用户信息等详细信息。

名称	类型	描述	示例
no	int32	版本号。通常是一个整数，每次新版本发布时都会递增。
comment可为空	string	对本次修订所做的更改进行描述。
meta可为空	string	与版本相关的元数据，可能包括标签或关键词等详细信息。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	此版本创建的日期和时间。
modifiedBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	此版本最后修改的日期和时间。
contentUrl可为空	string	访问此版本内容的网址。
references可为空	ReferenceResponseModel	与本次修订相关的参考资料列表，例如相关文档或资源。

Ƭ TagResponseInfoModel

表示标签的响应模型，包括其元数据和状态。

名称	类型	描述	示例
id可为空	string	标签的唯一标识符。
parentId可为空	string	父标签的唯一标识符（如有）。
realName可为空	string	标签的显示名称。
order	int32	标签在其同级元素中的显示顺序。
url可为空	string	与标签关联的 URL，通常用于导航。
iconCssClass可为空	string	用于视觉呈现的标签图标的 CSS 类。
color可为空	string	标签关联的颜色，用于视觉呈现。
isFavorites	Boolean	指示该标签是否被标记为收藏。
isPersonal	Boolean	指示该标签是否为用户个人所有。
orgId可为空	string	与该标签关联的组织的唯一标识符。
documentCount	int32	与该标签关联的文档数量。
name可为空	string	用于识别和搜索的标签名称。
isSharedFolder	Boolean	指示该标签是否为共享文件夹。
autoAssignMinPermissions	Boolean	指示是否自动分配最低权限。
documentGrant可为空	AccessEntryStringDto	获取共享文件夹下文档的访问权限列表。
sharedFolderGrant可为空	AccessEntryStringDto	获取共享文件夹的访问权限列表。

Ƭ DraftVO

表示草稿文档的视图模型，封装了与草稿相关的所有相关信息和元数据。

名称	类型	描述	示例
id可为空	string	草稿的唯一标识符。
type可为空	string	草稿类型。
title可为空	string	草案标题。
displayName可为空	string	草稿的显示名称。
description可为空	string	草案简述。
ext可为空	string	草稿文档的文件扩展名。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	草稿的创建日期和时间。
isDraft	Boolean	指示该文档是否为草稿。
isApproval	Boolean	表明该草案是否需要批准。
contentType可为空	string	草稿的内容类型。
contentUrl可为空	string	访问草案内容的网址。
revisionNo	int32	草案的修订号。
revisionContentUrl可为空	string	访问该草案特定修订版本内容的网址。
isSystemReserved	Boolean	表示该选秀权是否已被系统保留。
hideOnMobile	Boolean	指示是否应在移动设备上隐藏草稿。
meta可为空	string	草稿相关的元数据。
hideInDocumentPortal	Boolean	指示是否应在文档门户中隐藏草稿。
isResource	Boolean	指示该文档是否被视为资源。
organizationId可为空	string	与该草案相关的组织标识符。
organizationIdPath可为空	string	与草案关联的组织标识符路径。
thumbnail可为空	string	草稿缩略图的网址。
modified可为空	ISO DateTime Sting	草稿最后修改的日期和时间。
modifiedBy	SampleUserResponseModel
customPermissions可为空	Array<string>	与草稿关联的自定义权限列表。
effectiveOps可为空	string	对草稿可以进行的有效操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	该草案的相关参考文献列表。
revisions可为空	RevisionResponseModel	草案修订清单。

Ƭ AclEntryQueryModel

定义子角色的 ACL 条目权限。

名称	类型	描述	示例
sub	RoleResponseModel
ops可为空	Array<string>	已授权的操作。
opflags	int32	用于额外控制的操作标志。

Ƭ RoleResponseModel

代表系统中的一个角色。

名称	类型	描述	示例
id可为空	string	角色的唯一标识符。
name可为空	string	职位名称。
type可为空	string	职位类型。

Ƭ AccessEntryStringDto

访问入口字符串 Dto

名称	类型	描述	示例
role可为空	string	角色名称	"Tester"
ops可为空	Array<string>	操作：/ 执行：["执行"] / 读取：["执行", "读取"] / 写入：["执行", "读取", "更新"]	["Execute","Read","Update"]

Ƭ BatchDeleteDocumentsRequestModel

批量删除文档信息

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档 ID	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]
force	Boolean	是否强制删除文档
permanent	Boolean	是否永久删除文档

Ƭ BatchRestoreDocumentsRequestModel

文档信息批量恢复

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档 ID	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]

Ƭ DocumentPropertyRequestModel

文档属性

名称	类型	描述	示例
newName可为空	string	新文档名称	"newDocument"
meta可为空	string	文档元数据	"DSC_PROVIDER=CSV"
description可为空	string	文档描述	"Document Description"
fontOriginalName可为空	string	字体文档原名	"Oswald"
hideOnMobile可为空	Boolean	是否在移动设备上隐藏文档
hideInDocumentPortal可为空	Boolean	是否在文档门户中隐藏文档

Ƭ BatchHideDocumentInDocumentPortalResponseModel

批量隐藏文档门户中的文档

名称	类型	描述	示例
updated_Document_Ids可为空	Array<string>	更新文档 ID。
updated_Failed_Documents可为空	UpdateFailedInfo	更新失败的文档。

Ƭ UpdateFailedInfo

更新隐藏文档失败信息

名称	类型	描述	示例
documentIds可为空	Array<string>	文档 ID 列表
error	ErrorContent

Ƭ ErrorContent

名称	类型	描述	示例
code	ServiceErrorCodeEnum
message可为空	string
context可为空	any

Ƭ ServiceErrorCodeEnum

Enum:

• UserInfoNotFoundErrorCode
• UserInfoUpdateFailedErrorCode
• RequiredParameterMissingErrorCode
• DocumentNameExistsErrorCode
• DocumentAccessDeniedErrorCode
• NoEntityPermissionErrorCode
• NoSufficientPermissionsErrorCode
• ExceedLicenseCountErrorCode
• DocumentNotFoundErrorCode
• UnknownDocumentTypeErrorCode
• DocumentUsedByOtherDocumentsErrorCode
• NoEntityPermissionToRenameErrorCode
• RemoveDefaultThemeErrorCode
• NoPermissionErrorCode
• RemoveBuiltInDocumentErrorCode
• UpdateDocumentDescriptionErrorCode
• InvalidDocumentNameErrorCode
• InvalidDocumentTypeErrorCode
• InvalidTagNameErrorCode
• TagNotFoundErrorCode
• TagNameExistsErrorCode
• TagUrlNameExistsErrorCode
• TagOrderExistsErrorCode
• TagIdSameErrorCode
• TagOrderNullErrorCode
• RemoveDefaultLanguageResourceErrorCode
• UnknownDeleteErrorCode
• DuplicateDocumentErrorCode
• AddOrRemoveTagDocNotFoundErrorCode
• AddTagTagNotFoundErrorCode
• SystemReservedTagErrorCode
• TagOrganizationIdInvalidErrorCode
• ToTagIdIsChildrenOfFromTagErrorCode
• DraftIsApprovalErrorCode
• DraftIsDisabledErrorCode
• TagLikeFavoriteDeleteErrorCode
• RemoveUserSyncDatasetErrorCode
• ToTagCannotBeSharedTagErrorCode
• ParentTagCannotBeSharedTagErrorCode
• DocumentDoesNotBelongToTagErrorCode
• FailedToUpdateReferencesErrorCode
• DocumentDoesNotExistErrorCode
• DocumentAttachmentDoesNotExistErrorCode

Ƭ BatchHideDocumentInDocumentPortalRequestModel

文档门户中隐藏了批次文档信息

名称	类型	描述	示例
documentIds	Array<string>	批量操作文档 ID	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]
hideInDocumentPortal	Boolean	是否在文档门户中隐藏文档

Ƭ CopyDocumentRequestModel

复制文件基本信息

名称	类型	描述	示例
newDocName	string	新文档名称	"newDocumentName"
currentTagId可为空	string	当前标签 ID	"D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3"
copyAsTemplate	Boolean	是否将文档复制为模板，使用范围：报告文档。

Ƭ ChangeCategoriesRequestModel

表示更改与一批文档关联的类别（标签）的请求模型。 此模型支持根据指定的操作类型添加、删除或替换标签。

名称	类型	描述	示例
documentIds可为空	Array<string>	获取要修改的文档的唯一标识符列表。	["F00FC3E6-8554-467D-9A7E-4598E623BB2F","F00FC3E6-8554-467D-9A7E-4598E623BB2D"]
tagIds可为空	Array<string>	获取要添加、删除或替换的标签的唯一标识符列表。	["D01EF9CA-48A2-4ABA-B54E-AD9DA89955F3","D02EF9CA-48A2-4ABA-B54E-AD9DA89955F4"]
operationType可为空	string	获取要对指定文档的标签执行的操作类型。

Ƭ SetHomeDocumentRequestModel

表示将指定文档设置为当前用户的主页文档的请求模型。

名称	类型	描述	示例
documentId可为空	string	获取或设置要设为主页文档的文档的唯一标识符。

Ƭ DocumentPaginationResponseModel

表示分页文档查询的响应模型。

名称	类型	描述	示例
pagination	PaginationModel
data可为空	DocumentVO	一个只读的文档视图对象 (VO) 列表，代表文档的当前页面。每个 DocumentVO 都包含文档元数据以及显示或处理所需的任何其他信息。

Ƭ PaginationModel

此模型用于表示返回项目列表的查询的分页信息。它通过指定每页的大小和当前页码来管理大型数据集的分页。

名称	类型	描述	示例
pageSize	int32	获取或设置单个页面上要显示的项目数量。
pageNumber	int32	获取或设置当前页码。
total	int64	获取或设置所有页面上的项目总数。

Ƭ QueryDocumentsWithPaginationRequestModel

表示用于查询带分页功能的文档的请求模型。

名称	类型	描述	示例
documentId可为空	string	获取或设置文档 ID。	"e3808c7e-c0e7-44da-96a2-200b3bb216c6"
search可为空	string	获取或设置搜索关键字。	"example search keyword"
types可为空	string	获取或设置要筛选的文档类型。	"example document type"
orderBy可为空	string	获取或设置用于对文档进行排序的字段。	"example field name"
pageSize	int32	获取或设置每页显示的文档数量。	10
pageNumber	int32	获取或设置要显示的页码。	1
deleted	Boolean	获取或设置一个值，该值指示是否应将已删除的文档包含在结果中。	true
searchForAllTags	Boolean	获取或设置一个值，该值指示是否搜索所有标签。
disableHideInDocumentPortalFilter	Boolean	获取或设置一个值，该值指示是否禁用文档门户中的隐藏筛选器。	true
enableDataModelFilter	Boolean	获取或设置一个值，该值指示是否启用数据模型筛选器。	true
isSystemReserved可为空	Boolean	获取或设置一个值，该值指示文档是否为系统保留文档。	true
createdTimeRange可为空	Array<string>	获取或设置文档的创建时间范围。
modifiedTimeRange可为空	Array<string>	获取或设置文档的修改时间范围。
creator可为空	string	获取或设置文档的创建者。	"John Doe"
modifier可为空	string	获取或设置文档的修饰符。	"Jane Smith"
fromAdminPortal	Boolean	获取或设置一个值，该值指示请求是否来自管理门户。	true
extendQuery	ExtendQuery
includeIndirectReference	Boolean	获取或设置一个值，该值指示是否包含间接引用文档。	true
organizationId可为空	string	获取或设置组织 ID。 如果此属性有值，则会在查询之前创建一个具有两个角色（“所有人”和组织 ID）的新虚拟用户。 整个查询将使用此虚拟用户作为当前用户。 此设置仅对系统管理员有效。	"e3808c7e-c0e7-44da-96a2-200b3bb216c6"
includeDocTypeExtFields	Boolean	此属性仅在查询特定类型的文档时生效。 如果设置为 true，则会根据分页将文档扩展表中的字段加载到当前页。
extFilter	ExtFieldsFilter

Ƭ ExtFieldsFilter

简单外部字段过滤器（无嵌套）

名称	类型	描述	示例
logic	FilterLogic
conditions可为空	ExtFieldsFilterCondition	筛选条件列表

Ƭ FilterLogic

Enum:

• And
• Or

逻辑运算符

* 与 - 0 -
* 或 - 1 -

Ƭ ExtFieldsFilterCondition

单滤器条件

名称	类型	描述	示例
field可为空	string	字段名称
operator	FilterOperator
value可为空	any	价值

Ƭ FilterOperator

Enum:

• Equals
• NotEquals
• GreaterThan
• GreaterThanOrEqual
• LessThan
• LessThanOrEqual
• Contains
• StartsWith
• EndsWith

筛选运算符

* 等于 - 0 - 等于，=
* 不等于 - 1 - 不等于，!=
* 大于 - 2 - 大于，>
* 大于等于 - 3 - 大于或等于，>=
* 小于 - 4 -
* 小于等于 - 5 -
* 包含 - 6 - 包含
* 以……开头 - 7 - 以……开头
* 以……结尾 - 8 - 以……结尾

Ƭ DocumentTagPaginationRequestModel

文档分页请求模型

名称	类型	描述	示例
documentId可为空	string	获取或设置文档 ID。	"e3808c7e-c0e7-44da-96a2-200b3bb216c6"
pageSize	int32	获取或设置每页显示的文档数量。	10
pageNumber	int32	获取或设置要显示的页码。	1
orderBy可为空	string	获取或设置用于对文档进行排序的字段。	"creationDate"
disableHideInDocumentPortalFilter	Boolean	获取或设置一个值，该值指示是否禁用文档门户中的隐藏筛选器。
filterByType可为空	string	获取或设置要筛选的文档类型。	"report"
isFromExportPage	Boolean	获取或设置一个值，该值指示查询是否来自导出页面。
search可为空	string	获取或设置文档标题的搜索关键字。	"annual report"
createdTimeRange可为空	Array<string>	获取或设置文档的创建时间范围。
modifiedTimeRange可为空	Array<string>	获取或设置文档的修改时间范围。
creator可为空	string	获取或设置文档的创建者。	"John Doe"
modifier可为空	string	获取或设置文档的修饰符。	"Jane Smith"
lng可为空	string	获取或设置语言代码。	"en-US"
extendQuery	ExtendQuery
includeIndirectReference	Boolean	获取或设置一个值，该值指示是否包含间接引用文档。 仅当 extendQuery 表示的含义包含“引用”时，此配置才生效。	true

Ƭ QueryDocumentTypesResponseModel

表示 QueryDocumentTypes 操作的响应模型，其中包含文档类型的集合。

名称	类型	描述	示例
documentTypes可为空	DocumentTypeViewModel	文档类型标识符列表。

Ƭ DocumentTypeViewModel

表示文档类型的视图模型，封装了文档类型的关键信息和特征。

名称	类型	描述	示例
key可为空	string	文档类型的唯一标识符。
baseDocumentTypeKey可为空	string	如果适用，则表示此文档类型继承自的基本文档类型的键。
name可为空	string	文档类型名称。
description可为空	string	文档类型简述。
iconCssClass可为空	string	用于表示文档类型的图标的 CSS 类。此类可用于 UI 组件中，以显示与文档类型关联的图标。
knownFileTypes可为空	Array<string>	与文档类型关联的文件扩展名列表。
knownContentTypes可为空	Array<string>	与文档类型关联的 MIME 类型列表。
containsResource	Boolean	指示文档类型是否包含图像或其他嵌入式内容等资源。
customPermissions可为空	Array<string>	访问或操作此类文档所需的自定义权限列表。

Ƭ DocumentTranslateTitleRequest

翻译标题的语言代码和标题模型

名称	类型	描述	示例
translateTitles	DocumentTranslateTitleItem	翻译标题的语言代码和标题列表

Ƭ DocumentTranslateTitleItem

文件翻译标题

名称	类型	描述	示例
languageCode	string	语言代码	"EN-US"
title可为空	string	文档翻译标题	"Translate title"
isDefault	Boolean	默认标题与原始文档名称相同

Ƭ DocumentTranslateTitle

名称	类型	描述	示例
docId可为空	string
languageCode可为空	string
title可为空	string
isDefault	Boolean

Ƭ EncryptPathResponseModel

名称	类型	描述	示例
path可为空	string

Ƭ EncryptPathRequestModel

名称	类型	描述	示例
path可为空	string

Ƭ ExportRequestModel

表示一种出口模式。

名称	类型	描述	示例
items	ExportItemModel	需要出口的物品。
includeDocumentPermissions	Boolean	导出文档时是否包含文档权限，默认值为 false。	true
excludeReferenceDocumentTypes可为空	Array<string>	不允许导出的引用文档的文档类型，其优先级高于参数“IncludeReferenceDocumentTypes”。	["dst","dbd"]
includeReferenceDocumentTypes可为空	Array<string>	允许导出的引用文档的文档类型，其优先级低于参数“ExcludeReferenceDocumentTypes”。	["dst","dbd"]
includeDocumentScheduleTasks	Boolean	导出文档时是否包含文档的计划任务，默认值为 false。
documentPermissionTemplateMappings可为空	DocumentPemissionTemplateMappingModel	文档与权限模板之间的应用关系。

Ƭ ExportItemModel

表示出口商品模型。

名称	类型	描述	示例
type	string	需要导出的项目类型，有效类型如下： "$$documents" -> 文档, "sys-conf-ui" -> 用户界面设置, "sys-cat" -> 类别, "sys-clp" -> 自定义语言包, "sys-ctheme" -> 自定义主题, "sys-et" -> 导出模板, "sys-role" -> 角色, "sys-st" -> 计划模板, "sys-secprovider" -> 安全providers, "sys-secset" -> 安全设置, "sys-uf" -> 用户功能, "sys-conf-wq" -> 工作队列设置, "auditLogConfiguration" -> 审计日志设置, "sys-conf-dashboard-common" -> 仪表盘通用设置, "sys-conf-dashboard-designer" -> 仪表盘设计器设置, "sys-conf-dashboard-view" -> 仪表盘视图设置, "sys-conf-ddt" -> 默认文档主题, "sys-conf-es" -> 电子邮件设置, "sys-conf-rs" -> 报告设置, "sys-conf-ss" -> 计划设置,	"sys-conf-ui"
items	Array<string>	需要导出的获取或设置项目。	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]

Ƭ DocumentPemissionTemplateMappingModel

名称	类型	描述	示例
documentId可为空	string	文档编号。
permissionTemplates可为空	Array<string>	要应用的权限模板 ID 列表。

Ƭ ImportResult

表示导入结果模型。

名称	类型	描述	示例
documents可为空	DocumentImportResult	获取或设置导入的文档。
settings可为空	UploadSetting	获取或设置导入的设置。

Ƭ DocumentImportResult

表示文档导入结果模型。

名称	类型	描述	示例
success	Boolean	获取或设置文档导入结果。
operation	DocumentOperation
error	ImportError
document	UploadDocument

Ƭ UploadSetting

表示上传设置模型。

名称	类型	描述	示例
name可为空	string	获取或设置设置名称。
type可为空	string	获取或设置设置类型。

Ƭ DocumentOperation

Enum:

• Add
• Update
• Ignore
• Upgrade

导入文档操作类型枚举。

* 添加 - 0 - 添加文档。
* 更新 - 1 - 更新文档。
* 忽略 - 3 - 忽略文档。
* 升级 - 4 - 升级文档。

Ƭ ImportError

名称	类型	描述	示例
errorCode	int32
errorText可为空	string
context可为空	any

Ƭ UploadDocument

表示上传文档模型。

名称	类型	描述	示例
id可为空	string	获取或设置文档 ID。
title可为空	string	获取或设置文档标题。
documentType可为空	string	获取或设置文档类型。
fileExt可为空	string	获取或设置文档文件扩展名。
contentType可为空	string	获取或设置文档内容类型。
createdBy可为空	string	获取或设置文档创建者。
modifiedBy可为空	string	获取或设置文档编辑器。
created可为空	ISO DateTime Sting	获取或设置文档创建时间。
modified可为空	ISO DateTime Sting	获取或设置文档修改时间。

Ƭ PermissionRequestModel

权限请求模型

名称	类型	描述	示例
grantCollection可为空	AccessEntryStringDto	待授予的权限集合
revokeCollection可为空	AccessEntryStringDto	待撤销权限的集合

Ƭ BatchChangePermissionRequestModel

批量更改文档权限请求模型

名称	类型	描述	示例
documentIds可为空	Array<string>	变更权限的文档 ID。	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]
operationType可为空	string	操作类型（新增/移除现有/移除现有并新增）	"AddNew"
grantCollection可为空	AccessEntryStringDto	待授予权限的集合。
revokeCollection可为空	AccessEntryStringDto	要撤销的权限集合。仅当 OperationType 为“Remove”时生效。

Ƭ MinNeededPermissionRequestModel

授予当前文档请求模型中引用文档所需的最小权限

名称	类型	描述	示例
role可为空	string	角色名称	"Tester"

Ƭ BatchApplyMinNeededPermissionRequestModel

批量授予对当前文档请求模型中引用文档所需的最小权限

名称	类型	描述	示例
documentIds可为空	Array<string>	文档 ID	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]
roleNames可为空	Array<string>	角色名称	["Tester","Viewer"]

Ƭ QueueStatsResponseModel

表示排队统计响应模型。

名称	类型	描述	示例
workers可为空	WorkerInfoViewModel	获取或设置员工信息列表。
tasks可为空	CommonTaskInfo	获取或设置任务信息列表。

Ƭ WorkerInfoViewModel

构建员工信息模型。

名称	类型	描述	示例
id可为空	string	获取或设置工作者 ID。
url可为空	string	获取或设置工作进程 URL。
lastSeen	ISO DateTime Sting	获取或设置工作人员的最后在线时间。
tasksInProgress	int32	获取或设置工作人员正在进行的任务数量。
displayName可为空	string	获取或设置工作进程的显示名称。
specializations可为空	Array<string>	获取或设置工人的专业技能。

Ƭ CommonTaskInfo

表示一个通用的任务信息响应模型。

名称	类型	描述	示例
taskID	TaskIDViewModel
workerUrl可为空	string	获取或设置工作进程 URL。
workerID可为空	string	获取或设置工作进程 ID。
initiator可为空	string	获取或设置任务发起者。
documentName可为空	string	获取或设置文档名称。
displayDocName可为空	string	获取或设置显示名称。
documentId可为空	string	获取或设置文档 ID。
documentType可为空	string	获取或设置文档类型。
startTime	ISO DateTime Sting	获取或设置任务开始时间。
endTime可为空	ISO DateTime Sting	获取或设置任务结束时间。
progress可为空	string	获取或设置任务进度。
errorMessage可为空	string	获取或设置任务错误消息。
description可为空	string	获取或设置任务描述。
breakStatus	CommonTaskInfo+TaskStatus
status	CommonTaskInfo+TaskStatus
type	CommonTaskInfo+TaskType

Ƭ TaskIDViewModel

表示任务 ID 视图模型。

名称	类型	描述	示例
id可为空	string	获取或设置任务 ID。
parent	TaskIDViewModel

Ƭ CommonTaskInfo+TaskStatus

Enum:

• NotStarted
• WaitingForActivation
• WaitingToRun
• Started
• ReadingResult
• Verifying
• Canceled
• Failed
• Finished

任务状态枚举

* NotStarted - 0 - 未启动。
* WaitingForActivation - 1 - 等待激活。
* WaitingToRun - 2 - 等待运行。
* Started - 3 - 已启动。
* ReadingResult - 4 - 正在读取结果。
* Verifying - 5 - 正在验证。
* Canceled - 6 - 已取消。
* Failed - 7 - 失败。
* Finished - 8 - 已完成。

Ƭ CommonTaskInfo+TaskType

Enum:

• Queue
• Scheduler

任务类型枚举。

* 队列 - 0 - 队列任务。
* 调度器 - 1 - 调度器任务。